Skip to content

Zigbee Switch: Add support/handling for Stateless Step Capabilities#2818

Open
wkhenon wants to merge 1 commit intomainfrom
zigbee-switch/stateless-capabilities
Open

Zigbee Switch: Add support/handling for Stateless Step Capabilities#2818
wkhenon wants to merge 1 commit intomainfrom
zigbee-switch/stateless-capabilities

Conversation

@wkhenon
Copy link
Copy Markdown
Contributor

@wkhenon wkhenon commented Mar 2, 2026 •
edited
Loading

Check all that apply

Type of Change

  • WWST Certification Request
    • If this is your first time contributing code:
      • I have reviewed the README.md file
      • I have reviewed the CODE_OF_CONDUCT.md file
      • I have signed the CLA
    • I plan on entering a WWST Certification Request or have entered a request through the WWST Certification console at developer.smartthings.com
  • Bug fix
  • New feature
  • Refactor

Checklist

  • I have performed a self-review of my code
  • I have commented my code in hard-to-understand areas
  • I have verified my changes by testing with a device or have communicated a plan for testing
  • I am adding new behavior, such as adding a sub-driver, and have added and run new unit tests to cover the new behavior

Description of Change

Summary of Completed Tests

@wkhenon wkhenon changed the base branch from main to feature/color_temp_range March 2, 2026 21:53
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 2, 2026

Invitation URL:
https://bestow-regional.api.smartthings.com/invite/RBlEbJ99NvjE

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 2, 2026 •
edited
Loading

Test Results

   72 files    494 suites   0s ⏱️
2 710 tests 2 710 ✅ 0 💤 0 ❌
4 579 runs  4 579 ✅ 0 💤 0 ❌

Results for commit 82cdfe2.

♻️ This comment has been updated with latest results.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 2, 2026 •
edited
Loading

File Coverage
All files 96% ✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-switch/src/inovelli/vzm32-sn/init.lua 95% ✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-switch/src/init.lua 92% ✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-switch/src/lazy_load_subdriver.lua 57% ❌
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-switch/src/preferences.lua 97% ✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-switch/src/color_temp_range_handlers/init.lua 71% ❌
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-switch/src/laisiao/init.lua 96% ✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-switch/src/frient/init.lua 94% ✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-switch/src/aqara-light/init.lua 92% ✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-switch/src/inovelli/init.lua 98% ✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-switch/src/configurations/init.lua 98% ✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-switch/src/aqara/init.lua 94% ✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-switch/src/frient-IO/unbind_request.lua 71% ❌
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-switch/src/frient-IO/init.lua 88% ❌
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-switch/src/tuya-multi/can_handle.lua 90% ✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-switch/src/inovelli/vzm30-sn/init.lua 95% ✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-switch/src/aqara/version/init.lua 94% ✅

Minimum allowed coverage is 90%

Generated by 🐒 cobertura-action against 82cdfe2

@wkhenon wkhenon force-pushed the zigbee-switch/stateless-capabilities branch 2 times, most recently from 535962c to cf1fc47 Compare March 3, 2026 15:24
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 3, 2026

Duplicate profile check: Warning - duplicate profiles detected.
color-temp-bulb-2700K-6500K.yml == color-temp-bulb.yml

@greens greens force-pushed the feature/color_temp_range branch from 3d5baa4 to 8855768 Compare March 3, 2026 21:17
@wkhenon wkhenon force-pushed the zigbee-switch/stateless-capabilities branch 2 times, most recently from c0a48c5 to f4a7af9 Compare March 4, 2026 17:26
Base automatically changed from feature/color_temp_range to main March 4, 2026 19:07
greens
greens reviewed Mar 4, 2026
View reviewed changes
@wkhenon wkhenon force-pushed the zigbee-switch/stateless-capabilities branch from f10a277 to 1bbafc5 Compare March 9, 2026 14:30
hcarter-775
hcarter-775 reviewed Mar 9, 2026
View reviewed changes
@wkhenon wkhenon force-pushed the zigbee-switch/stateless-capabilities branch from 1bbafc5 to 21d5850 Compare March 9, 2026 20:23
greens
greens reviewed Mar 10, 2026
View reviewed changes
@wkhenon wkhenon force-pushed the zigbee-switch/stateless-capabilities branch from 4ad4ca3 to 75ef0dc Compare March 11, 2026 19:24
greens
greens reviewed Mar 11, 2026
View reviewed changes
@wkhenon wkhenon force-pushed the zigbee-switch/stateless-capabilities branch from 671071f to 2023b46 Compare March 12, 2026 19:08
@hcarter-775 hcarter-775 force-pushed the zigbee-switch/stateless-capabilities branch from 2023b46 to 2a1d09d Compare March 26, 2026 18:40
tpmanley
tpmanley reviewed Mar 26, 2026
View reviewed changes
tpmanley
tpmanley reviewed Mar 30, 2026
View reviewed changes
tpmanley
tpmanley reviewed Mar 30, 2026
View reviewed changes
nickolas-deboom
nickolas-deboom reviewed Apr 1, 2026
View reviewed changes
drivers/SmartThings/zigbee-switch/src/stateless_handlers/init.lua Outdated
Comment on lines +21 to +22
local kelvin_min = device:get_field(switch_utils.KELVIN_MIN);
local kelvin_max = device:get_field(switch_utils.KELVIN_MAX);
Copy link
Copy Markdown
Contributor

@nickolas-deboom nickolas-deboom Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These fields are set with the endpoint appended to the field name, but are being read here without the endpoint.

Copy link
Copy Markdown
Contributor

@nickolas-deboom nickolas-deboom Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also noticed that the 3 lines above here have semicolons at the end that should be removed

Copy link
Copy Markdown
Contributor

@hcarter-775 hcarter-775 Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done to both. This was a bit of a weird issue- in matter we have the component_to_endpoint logic to get endpoints from a component, but in zigbee we don't. For now, I removed the endpoint logic altogether, so we cannot support different bounds across parent/child zigbee bulbs. I think this is an ok trade-off for the work it might take to add new infrastructure to handle this.

@hcarter-775 hcarter-775 force-pushed the zigbee-switch/stateless-capabilities branch from 74f650c to 555e4e3 Compare April 1, 2026 20:40
hcarter-775
hcarter-775 reviewed Apr 2, 2026
View reviewed changes
drivers/SmartThings/zigbee-switch/src/color_temp_range_handlers/init.lua Outdated
Comment on lines +10 to +11
local COLOR_TEMPERATURE_MIRED_MAX = 1000 -- 15000 Kelvin
local COLOR_TEMPERATURE_MIRED_MIN = 67 -- 1000 Kelvin
Copy link
Copy Markdown
Contributor

@hcarter-775 hcarter-775 Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A note to reviewers- while looking at this all, I started noticing that while we are saving these fields in Kelvin, almost all functionality involving these occurs in Mireds. Therefore, I have altered the flow to more directly use mireds, only converting into kelvin at the specific colorTemperatureRange step.

I believe this should simplify the constant conversion back and forth.

aleclorimer
aleclorimer reviewed Apr 2, 2026
View reviewed changes
drivers/SmartThings/zigbee-switch/src/stateless_handlers/can_handle.lua
-- Copyright 2026 SmartThings, Inc.
-- Licensed under the Apache License, Version 2.0

local capabilities = require "st.capabilities"
Copy link
Copy Markdown
Contributor

@aleclorimer aleclorimer Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Move this inside the function call for slight memory savings

Copy link
Copy Markdown
Contributor

@hcarter-775 hcarter-775 Apr 2, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure that will cause savings in this case, since st.capabilities is already required at the top of the main init.lua file.

@hcarter-775 hcarter-775 force-pushed the zigbee-switch/stateless-capabilities branch from 6a091be to 0d7e0a1 Compare April 3, 2026 16:58
nickolas-deboom
nickolas-deboom reviewed Apr 6, 2026
View reviewed changes
drivers/SmartThings/zigbee-switch/src/stateless_handlers/init.lua Outdated
local clusters = require "st.zigbee.zcl.clusters"
local switch_utils = require "switch_utils"

-- These values are the mired versions of the config bounds in the default profiles
Copy link
Copy Markdown
Contributor

@nickolas-deboom nickolas-deboom Apr 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Which default profiles is this comment referring to? color-temp-bulb.yml uses 2700K for example. I'm guessing this really just means a default range that would represenet the widest supported color temp range across all of the profiles?

Copy link
Copy Markdown
Contributor

@hcarter-775 hcarter-775 Apr 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just made some updates, I'd originally used the Matter default profiles (which use 2200) as the basis, but decided to use the default Zigbee bounds instead, like you'd pointed out.

nickolas-deboom
nickolas-deboom approved these changes Apr 6, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@nickolas-deboom nickolas-deboom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some minor comments but the rest looks good to me 👍

@hcarter-775 hcarter-775 force-pushed the zigbee-switch/stateless-capabilities branch 3 times, most recently from 0387687 to 36bbf2b Compare April 7, 2026 15:43
@wkhenon @hcarter-775
CHAD-17426: Add stateless step capabilities to zigbee-switch
82cdfe2 
Co-authored-by: Harrison Carter <harrison.carter@smartthings.com>
@hcarter-775 hcarter-775 force-pushed the zigbee-switch/stateless-capabilities branch from 36bbf2b to 82cdfe2 Compare April 7, 2026 15:54
cjswedes
cjswedes approved these changes Apr 7, 2026
View reviewed changes
drivers/SmartThings/zigbee-switch/src/color_temp_range_handlers/init.lua
else
device.log.warn_with({hub_logs = true}, string.format("Device reported a min color temperature %d K that is not lower than the reported max color temperature %d K", temp_in_kelvin, max))
end
device:set_field(switch_utils.MIRED_MAX_BOUND, max_mired_bound, {persist = true})
Copy link
Copy Markdown
Contributor

@cjswedes cjswedes Apr 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whats the reason for removing the endpoint from these field names? Same here:

SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-switch/src/color_temp_range_handlers/init.lua

Line 21 in 82cdfe2

device:set_field(switch_utils.MIRED_MIN_BOUND, min_mired_bound, {persist = true})

Copy link
Copy Markdown
Contributor

@hcarter-775 hcarter-775 Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oops, I resolved the conversation where this was discussed. See here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tpmanley tpmanley tpmanley left review comments

@hcarter-775 hcarter-775 hcarter-775 approved these changes

@cjswedes cjswedes cjswedes approved these changes

@nickolas-deboom nickolas-deboom nickolas-deboom approved these changes

@aleclorimer aleclorimer aleclorimer approved these changes

@pegor-karoglanian pegor-karoglanian Awaiting requested review from pegor-karoglanian

+1 more reviewer

@greens greens greens approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@wkhenon @greens @tpmanley @cjswedes @hcarter-775 @nickolas-deboom @aleclorimer